﻿#region License

// Another free, open solution by someone who gets it.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

#endregion

namespace Patterns.Validation.Formatting
{
	/// <summary>
	/// 	Defines an interface for value formatters.
	/// </summary>
	public interface IValueFormatter
	{
		/// <summary>
		/// 	Indicates whether the current <see cref = "IValueFormatter" /> can handle the specified <paramref name = "value" />.
		/// </summary>
		/// <param name = "value">The value for which to create a <see cref = "System.String" />.</param>
		/// <returns>
		/// 	<c>true</c> if the current <see cref = "IValueFormatter" /> can handle the specified value; otherwise, <c>false</c>.
		/// </returns>
		bool CanHandle(object value);

		/// <summary>
		/// 	Returns a <see cref = "System.String" /> that represents this instance.
		/// </summary>
		/// <param name = "value">The value for which to create a <see cref = "System.String" />.</param>
		/// <param name = "nestedPropertyLevel">
		/// 	The level of nesting for the supplied value. This is used for indenting the format string for objects that have
		/// 	no <see cref = "object.ToString()" /> override.
		/// </param>
		/// <returns>
		/// 	A <see cref = "System.String" /> that represents this instance.
		/// </returns>
		string ToString(object value, int nestedPropertyLevel = 0);
	}
}